home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 19 / Night Owl (The Best of Shareware)(NOPV 19)(1996).ISO / 007a / syedt22a.zip / SYNCEDIT.DOC < prev    next >
Text File  |  1995-11-28  |  24KB  |  505 lines

  1.  
  2.  
  3.  
  4.                                      SyncEdit
  5.                          The Synchronet Full-Screen Editor
  6.  
  7.  
  8.                         (c) Copyright 1995 Robert D. Bouman
  9.  
  10.                                 ALL RIGHTS RESERVED
  11.  
  12.  
  13.                                  Robert D. Bouman
  14.                                 94 W Roosevelt Ave.
  15.                                 Zeeland, MI  49464
  16.                                         USA
  17.  
  18.                              Fido:  1:2201/11
  19.                          Internet:  bouman@macatawa.org
  20.  
  21.  
  22.  
  23.  
  24.      
  25.      As this document covers both the freely distributable and registered 
  26.      versions, not all items apply to the demo version and are identified as 
  27.      such throughout the document.  
  28.  
  29.  
  30.  
  31.      ┌───────────────────────────────────────────────────────────────────────┐ 
  32.      │ ░▒▓█                         Description                         █▓▒░ │
  33.      └───────────────────────────────────────────────────────────────────────┘ 
  34.  
  35.      This product provides an integrated full-screen ANSI message editor for
  36.      use with the Synchronet bulletin board package.
  37.  
  38.  
  39.  
  40.      ┌───────────────────────────────────────────────────────────────────────┐ 
  41.      │ ░▒▓█                         Disclaimer                          █▓▒░ │
  42.      └───────────────────────────────────────────────────────────────────────┘ 
  43.  
  44.      The entire SyncEdit package is provided as is and comes with no warranty
  45.      of any kind, either expressed or implied.  In no event will Robert
  46.      Bouman be liable for damage resulting from the direct or indirect use of
  47.      this software.
  48.  
  49.      The user of these programs bears all risks as to their quality and
  50.      performance.  
  51.  
  52.      Users are encouraged to use common sense and back up all important system 
  53.      files using industry accepted methods before using this or any other
  54.      newly obtained application.  
  55.  
  56.  
  57.      ┌───────────────────────────────────────────────────────────────────────┐ 
  58.      │ ░▒▓█                       Special Thanks                        █▓▒░ │
  59.      └───────────────────────────────────────────────────────────────────────┘ 
  60.  
  61.      Special thanks goes to Bill Chronkite who has contributed heavily
  62.      thourghout SyncEdit's testing.  SyncEdit would not enjoy continued
  63.      development without his support.
  64.  
  65.  
  66.      ┌───────────────────────────────────────────────────────────────────────┐ 
  67.      │ ░▒▓█                       Included Files                        █▓▒░ │
  68.      └───────────────────────────────────────────────────────────────────────┘ 
  69.  
  70.      HISTORY.TXT        Revision history of SyncEdit
  71.      REGISTER.FRM       Registration form
  72.      SYNCEDIT.DOC       What you're reading now, the documentation
  73.      UPGRADE.DOC        Information on upgrading to this version of SyncEdit.
  74.      SYNCEDIT.EXE       The executable text editor
  75.      KEYGEN.EXE         Program to generate key file
  76.      SYNCEDIT.MAC       Example macro file
  77.      FEATURES.TXT       List of features included in SyncEdit to date
  78.  
  79.                        (files included in SYEDTDIC.ZIP)
  80.  
  81.      SYNCEDIT.DIC       Dictionary file for spell checker
  82.      IMPLIST.EXE        Program to import words into main dictionary file
  83.      IMPLIST.DOC        Instructions for using IMPLIST.EXE
  84.         
  85.  
  86.      ┌───────────────────────────────────────────────────────────────────────┐ 
  87.      │ ░▒▓█                     System Requirements                     █▓▒░ │
  88.      └───────────────────────────────────────────────────────────────────────┘ 
  89.  
  90.      An operational Synchronet BBS system, version 2.00 or greater. ANSI
  91.      emulation is required for the remote user of course, DOS 3.0+, a fossil
  92.      driver may be needed if you are currently using Digiboard or similar
  93.      product.  SYNCEDIT SUPPORTS FOSSIL AND DIRECT COMPORT I/O ONLY!
  94.  
  95.  
  96.  
  97.      ┌───────────────────────────────────────────────────────────────────────┐ 
  98.      │ ░▒▓█                     Distribution Method                     █▓▒░ │
  99.      └───────────────────────────────────────────────────────────────────────┘ 
  100.   
  101.      Freely distributable shareware.  This package may be uploaded, placed in
  102.      CD-ROM collections, or otherwise be freely disseminated as long as the
  103.      archive remains intact.  Only reasonable fees may charged for copying or
  104.      distributing, and no copyright or ownership may be claimed by parties
  105.      other than Robert Bouman.  This product is NOT in the "public domain".
  106.   
  107.      The latest version is always available via file request at 1:2201/11 as
  108.      SYNCEDIT (or SYEDTDIC for the dictionary files).
  109.  
  110.  
  111.  
  112.      ┌───────────────────────────────────────────────────────────────────────┐ 
  113.      │ ░▒▓█                         Limitations                         █▓▒░ │
  114.      └───────────────────────────────────────────────────────────────────────┘ 
  115.  
  116.      The demo version is a very functional editor, with no time limitations
  117.      or restrictions on usage except as noted above under "Distribution
  118.      method". The demo contains complete block editing and file functions,
  119.      but the spell checker and search/replace functions have a 10 second
  120.      delay imbedded in them.  Also, the demo does not allow the use of Sysop
  121.      definable TAGLINES.  There is a three second delay upon entry to the
  122.      editor as well.
  123.  
  124.      The key code activates all features and removes all "unregistered"
  125.      delays.  The tear line will not be added to messages written with a
  126.      registered version of SyncEdit.
  127.  
  128.      See "Registration" for specifics on how to obtain a key code.
  129.  
  130.      Both versions of SyncEdit are limited to a maximum of 500 lines of text.  
  131.  
  132.  
  133.  
  134.      ┌───────────────────────────────────────────────────────────────────────┐ 
  135.      │ ░▒▓█                        Installation                         █▓▒░ │
  136.      └───────────────────────────────────────────────────────────────────────┘ 
  137.  
  138.      SyncEdit is installed as an external message editor, and if one is
  139.      familiar with Synchronet and installing doors, there should be little
  140.      difficulty. However, it is assumed that the reader is familiar with
  141.      Synchronet and how to configure the BBS software.
  142.  
  143.  
  144.                                       Step 1
  145.  
  146.      Decide where you wish to place the external files, ie the SYNCEDIT.DIC,
  147.      SYNCEDIT.KEY and TAGLINE files, all of which are only activated by a
  148.      registered key code.  As mentioned earlier, remember that the dictionary
  149.      is distributed as a separate archive.
  150.  
  151.      If you plan on using a different directory from \SBBS\EXEC, create the
  152.      directory using any valid DOS name and path, with the DOS "MD"    
  153.      command.
  154.   
  155.      If used, copy SYNCEDIT.DIC into the directory you just created, and make
  156.      a note of the full path and name of this directory as you'll need that
  157.      information in a moment.  Otherwise, if using the BBS EXEC directory,
  158.      copy SYNCEDIT.DIC into \SBBS\EXEC.
  159.  
  160.  
  161.                                       Step 2
  162.  
  163.      You must run the program SETUP.EXE before you first use SyncEdit.  Be
  164.      sure to plug the external directory you created in the first step into
  165.      the top menu option.  After all the options have been set to your
  166.      preference, exit (press <ESC>).  SETUP will create a file called
  167.      SYNCEDIT.CFG.  Be sure to place this file into the same directory as
  168.      SYNCEDIT.EXE.
  169.  
  170.  
  171.                                     Step 3
  172.  
  173.      SYNCEDIT.EXE may be installed in any convenient directory, though we
  174.      suggest the \SBBS\EXEC subdirectory or a directory beneath \SBBS\EXEC
  175.      called SYNCEDIT.  If you place SYNCEDIT.EXE in a directory that's NOT
  176.      in your system path statement, then you must provide the full path to
  177.      this directory on the command line with the executable 
  178.      (C:\SYNCEDIT\SYNCEDIT %l .. .. ). 
  179.  
  180.  
  181.                                       Step 4
  182.  
  183.      Add SYNCEDIT to your BBS's external on-line programs menu via the
  184.      Synchronet configuration utility:  External Programs -> External Editors
  185.  
  186.      Before we get to installing SyncEdit, please note the command line used 
  187.      with SyncEdit:  
  188.  
  189.      c:\sbbs\syncedit\syncedit <NUM LINES> [PATH\FILE]
  190.                      or
  191.      %!syncedit <NUM LINES> [PATH\FILE]
  192.  
  193.  
  194.      A typical command line example might be:  
  195.  
  196.                           %!syncedit %l %f
  197.  
  198.      Left to right:  the name of the executable,  maximum number of lines
  199.      allowed in the editor, and the optional path\file_name to read into the
  200.      editor.
  201.  
  202.      You MUST include the full path and program name when installing SyncEdit
  203.      into SBBS.  If SYNCEDIT.EXE is in the \sbbs\exec directory, you could
  204.      use %!SYNCEDIT ... in the configuration of SyncEdit's command line.
  205.      However, if you aren't using the \sbbs\exec directory to hold
  206.      SYNCEDIT.EXE, you would have to include the full path as in
  207.      "C:\SBBS\SYNCEDIT\SYNCEDIT ...".
  208.  
  209.      The Synchronet parameter %l may be substituted for NUM LINES.  This is
  210.      handy if you wish the editor to use the default number of lines as 
  211.      configured within each of your BBS user levels.  
  212.  
  213.      We suggest the use of a separate external directory with the 
  214.      availability of user dictionaries.  Otherwise, the \EXEC directory may
  215.      become cluttered with dictionary files.
  216.  
  217.  
  218.      Hit INSERT on a blank line to start the process of adding the editor.  
  219.  
  220.      Below is an example intended to show a typical setup for SyncEdit, and 
  221.      should work for the vast majority of users.  Please note, SyncEdit 
  222.      *requires* the use of the XTRN.DAT drop file so be sure to configure 
  223.      Synchronet to drop the file as indicated below.
  224.  
  225.  
  226.                                   SyncEdit Editor
  227. ╔════════════════════════════════════════════════════════════════════════╗
  228. ║ Name                            SyncEdit                               ║
  229. ║ Internal Code                   SYNCEDIT                               ║
  230. ║ Local Command Line              %!syncedit %l %f                       ║
  231. ║ Remote Command Line             %!syncedit %l %f                       ║
  232. ║ Access Requirements             ANSI                                   ║
  233. ║ Intercept I/O Interrupts        No                                     ║
  234. ║ Quote Text                      Prompt User                            ║
  235. ║ QuickBBS Style Editor (MSGTMP)  No                                     ║
  236. ║ Expand line feeds to CRLF       No                                     ║
  237. ║ BBS Drop File Type              Synchronet      XTRN.DAT               ║
  238. ╚════════════════════════════════════════════════════════════════════════╝
  239.  
  240.  
  241.      Once again, this example will work if you have the directory where you 
  242.      placed SYNCEDIT.EXE in your path, and you placed your external files in
  243.      \SBBS\EXEC.  Otherwise, you will need to modify the above to match
  244.      your setup.
  245.  
  246.      If memory is tight, or you experience difficulties, add SyncEdit to your 
  247.      BBS global swap list.  This is accomplished within the Synchronet 
  248.      configuration utility.  
  249.  
  250.  
  251.      That's it, you and your users should now be able to use the editor!  
  252.  
  253.  
  254.  
  255.      ┌───────────────────────────────────────────────────────────────────────┐ 
  256.      │ ░▒▓█                      Using the Editor                       █▓▒░ │
  257.      └───────────────────────────────────────────────────────────────────────┘ 
  258.  
  259.      As SyncEdit contains an extensive built-in help system, we will not go 
  260.      into great detail here on the commands or how to use the editor.  
  261.  
  262.      All functions are available from the menu at the top of the screen by 
  263.      using CTRL-key combinations.  For instance, on-line help is available by 
  264.      using CTRL-P.  There are also several keyboard shortcuts, such as CTRL-O
  265.      for quick save, as well as the traditional "slash" commands (/A, /ABT,
  266.      /N, /S, /?).  Again, be sure to review the help system when you first
  267.      use the editor for more detailed information.
  268.  
  269.      The menu bar at the bottom of the editor reflects (left to right):
  270.   
  271.                 registration information (who the editor is registered to)
  272.                 maximum lines allowed
  273.                 number of lines used
  274.                 insert/delete mode status
  275.                 date
  276.                 time
  277.  
  278.  
  279.      ┌───────────────────────────────────────────────────────────────────────┐
  280.      │ ░▒▓█                    Sysop File Functions                     █▓▒░ │
  281.      └───────────────────────────────────────────────────────────────────────┘ 
  282.  
  283.      There are two Sysop only commands available from the File menu that are
  284.      accessible, and visible, only to user groups 90 and above (co-Sysops and
  285.      Sysops).  These commands are LoadFile and SaveFile which do exactly what
  286.      their names imply.
  287.  
  288.      LoadFile reads a separate text file into the current editing session.  
  289.      This function does not overwrite existing text, but rather inserts the
  290.      file at the current cursor position.
  291.  
  292.      SaveFile saves the current text to a file in ASCII format.
  293.  
  294.      Both LoadFile and SaveFile expect a full DOS path.
  295.  
  296.  
  297.  
  298.      ┌───────────────────────────────────────────────────────────────────────┐
  299.      │ ░▒▓█                      Sysop Hot Keys                         █▓▒░ │
  300.      └───────────────────────────────────────────────────────────────────────┘ 
  301.  
  302.      Several functions are also available to the sysop both when used locally
  303.      and when a remote user is using SyncEdit.  They are defined below.
  304.  
  305.      ALT+C - Allows you to chat with the remote user while they are editing a
  306.      message.  This function is only available when the user is at the main
  307.      editing screen.  ALT+C again to return to normal screen.
  308.  
  309.      ALT+H - Hang up on user and exit from SyncEdit.
  310.  
  311.      ALT+J - Drop to DOS.  This is available when the user is on-line as well
  312.      as when the editor is used locally.  It is available when the remote
  313.      user or local user is in the main editing screen only.
  314.  
  315.      ALT+K - When this key is pressed, SyncEdit will ignore key strokes from
  316.      the remote user.  Pressing this key again will return the editor to
  317.      normal function.
  318.  
  319.      ALT+D - Drops user to BBS without hanging up on them.
  320.  
  321.      F1 - Will display a status bar containing the sysop key information from
  322.      above.
  323.  
  324.      F9 - Will return the status bar to the normal user information display.
  325.  
  326.      F10 - Will remove the status bar completly from screen.
  327.  
  328.      ALT-+/- - Increase or decrease the amount of time the user has in
  329.      SyncEdit to write or edit a message.
  330.  
  331.  
  332.      ┌───────────────────────────────────────────────────────────────────────┐ 
  333.      │ ░▒▓█      Creating TAGLINE Files (registered version only)       █▓▒░ │
  334.      └───────────────────────────────────────────────────────────────────────┘ 
  335.  
  336.      The registered version of SyncEdit allows for the use of up to 20 
  337.      different tag lines.  Remember, all the *.TAG files, must be placed in 
  338.      the external directory pointed to by the first command line argument.  
  339.  
  340.      Each TAG file may be up to 600 bytes in length.  If these limits are
  341.      exceed, the file will be truncated.  Tag files may contain both ANSI or
  342.      ASCII text and must be named using any valid DOS name, with an extension
  343.      of .TAG.  These names may be descriptive, as in ANSI.TAG, ASCII.TAG,
  344.      simple as in 1.TAG, 2.TAG, or any other scheme you prefer.  Use
  345.      desecration when using tag lines, particularly those containing ANSI
  346.      escape codes as they can quickly become overdone and irritating to
  347.      readers of your messages (and network administrators).
  348.  
  349.      If more than one *.TAG file is found, SyncEdit will randomly select
  350.      a different *.TAG file each time the editor is called by the BBS.  
  351.      For example, if you have two *.TAG files, the odds are approximately 
  352.      50-50 that a particular tag file will be used.  If you have three tag 
  353.      files, the odds are 1 in 3, and so on.  If you only wish to have one tag 
  354.      line added by the editor, only define one tag file, for example 1.TAG.  
  355.      If you don't want any tag lines added, simply don't define any.  
  356.  
  357.      Note, the unregistered "SyncEdit" tear line is not user definable or 
  358.      modifiable.  The tear line is not appended by the registered version.
  359.  
  360.  
  361.  
  362.      ┌───────────────────────────────────────────────────────────────────────┐ 
  363.      │ ░▒▓█                   Sysop (only) Macro Files                  █▓▒░ │
  364.      └───────────────────────────────────────────────────────────────────────┘ 
  365.  
  366.      For the macros, a file named SYNCEDIT.MAC must be in the external
  367.      directory.  We have included a basic macro file so you have a reference
  368.      point for creating your own.
  369.  
  370.      There is a maximum of 40 macros lines allowed.  If this number is 
  371.      exceeded, only 40 will be used.  Lines that have a ';' in column one
  372.      will be skipped, which is primarily used for adding comments to the
  373.      macro file.  Blank lines are skipped also.  Everything else is   
  374.      considered a macro line.
  375.  
  376.      Macro lines 1-10 correspond to F1-F10 on the keyboard; 11-20 to
  377.      shift+F1-f10; 21-30 to ctrl+F1-F10; and finally 31-40 to alt+F1-F10.  For
  378.      example, if you have 11 lines that are considered macro lines, then you 
  379.      can insert those lines into your message by pressing F1-F10 and shift+F1.
  380.      If you press shirt+F2, the computer will beep telling you that there isn't
  381.      a macro associated with that key.
  382.  
  383.      One common use of a macros as implemented within SyncEdit is to allow
  384.      the Sysop to easily use different signatures, depending on the target
  385.      audience of the message.
  386.  
  387.  
  388.  
  389.      ┌───────────────────────────────────────────────────────────────────────┐
  390.      │ ░▒▓█                      User Dictionaries                      █▓▒░ │
  391.      └───────────────────────────────────────────────────────────────────────┘
  392.  
  393.      Any user that is allowed to use SyncEdit will be able to create their own 
  394.      custom dictionary.  SyncEdit will provide a menu item entitled ADD when 
  395.      it encounters a word during a spell checking session that it doesn't
  396.      believe is spelled correctly.  By simply choosing the add option the
  397.      highlighted word will be added to the users personal dictionary (*not*
  398.      the master dictionary).  Please note, SyncEdit doesn't delete user
  399.      dictionaries when there are changes to the BBS database.  Consequently,
  400.      if a user is deleted from the BBS database, the next person that has
  401.      the same user number will inherit the old dictionary.
  402.  
  403.  
  404.  
  405.      ┌───────────────────────────────────────────────────────────────────────┐ 
  406.      │ ░▒▓█                Registration Cost and Process                █▓▒░ │
  407.      └───────────────────────────────────────────────────────────────────────┘ 
  408.  
  409.      Registration fee is $20.00 (twenty dollars US).  That's right, only
  410.      twenty dollars.  This will get you a key code that will activate all the
  411.      editors features.
  412.  
  413.      Please review, complete and return the REGISTER.FRM (enclosed).  
  414.  
  415.  
  416.      ┌───────────────────────────────────────────────────────────────────────┐ 
  417.      │ ░▒▓█                          Cautions                           █▓▒░ │
  418.      └───────────────────────────────────────────────────────────────────────┘ 
  419.  
  420.      This product was designed specifically to interface with the Synchronet 
  421.      BBS system, and has not been tested with other BBS packages.  Though it 
  422.      may work with other BBS systems, we make no representation that it will.  
  423.  
  424.  
  425.  
  426.      ┌───────────────────────────────────────────────────────────────────────┐ 
  427.      │ ░▒▓█                      Technical Support                      █▓▒░ │
  428.      └───────────────────────────────────────────────────────────────────────┘ 
  429.  
  430.      Support is provided by calling the SyncEdit support BBS; The Game Room
  431.      (616)786-3650 and either posting a message to "Playster" in the SyncEdit
  432.      message section or by sending private e-mail, via FidoNet netmail
  433.      (1:2201/11) addressed to Robert Bouman or Internet e-mail addressed to
  434.      bouman@macatawa.org.
  435.  
  436.      Please note, we will do everything possible to assist folks in getting 
  437.      the freely distributable version up and running.  However, technical 
  438.      support is primarily intended for registered users.  They are after all, 
  439.      our paying customers.  
  440.  
  441.      Apparent bug reports should be forwarded as identified above.  Please 
  442.      provide as much detail as possible regarding your difficulty, ie hardware 
  443.      configuration, BBS setup (paths, etc), and a specific description of the 
  444.      problem.  
  445.  
  446.      Suggestions regarding new features, and comments in general are welcome 
  447.      from all users and should be forwarded as indicated above.  
  448.  
  449.  
  450.  
  451.      ┌───────────────────────────────────────────────────────────────────────┐ 
  452.      │ ░▒▓█                      Known "Anomalies"                      █▓▒░ │
  453.      └───────────────────────────────────────────────────────────────────────┘ 
  454.  
  455.      o SyncEdit is limited to a maximum of 500 lines of text.  If attempts are 
  456.        made to use more than 500 lines, the editor will continue to load and
  457.        enter into an editing session.  However, only the first 500 lines of
  458.        text will actually be edited and saved.
  459.  
  460.      o There seems to be some incompatibilities when SyncEdit is used under 
  461.        Novell DOS v7.  In particular, the problem occurs when attempting an
  462.        editing session from the WFC screen.  Usage of the editor from within
  463.        the BBS is not generally affected.
  464.  
  465.      o Due to the spelling library SyncEdit currently uses, there are times
  466.        the spell checker will flag words as misspelled when in fact the word 
  467.        is spelled correctly.  This may be most noticeable when adding words to 
  468.        one's personal dictionary.  We are aware of the problem, but due to the 
  469.        fact that we don't have the source code to the library we can't easily 
  470.        correct the problem.  The solution lies in either writing our own 
  471.        library from scratch or locating another spelling library.  We are 
  472.        investigating the options are planning to correct this situation in a
  473.        future release.
  474.  
  475.  
  476.  
  477.      ┌───────────────────────────────────────────────────────────────────────┐ 
  478.      │ ░▒▓█                       Upgrade Policy                        █▓▒░ │
  479.      └───────────────────────────────────────────────────────────────────────┘ 
  480.  
  481.      Registering SyncEdit is a one time ONLY process.  By purchasing the
  482.      registered version of SyncEdit, you get a life long "subscription" to
  483.      all future versions of SyncEdit.
  484.  
  485.  
  486.  
  487.      ┌───────────────────────────────────────────────────────────────────────┐ 
  488.      │ ░▒▓█                        Miscellaneous                        █▓▒░ │
  489.      └───────────────────────────────────────────────────────────────────────┘ 
  490.  
  491.      SyncEdit reads either the INPUT.MSG placed in the node directories by
  492.      the BBS, or the file passed to it from the BBS via the %f parameter,
  493.      EDITOR.INF, QUOTES.TXT, and Synchronet's drop file XTRN.DAT.  No other
  494.      files are read from or written to.
  495.  
  496.      If the LoadFile or SaveFile commands are used, SyncEdit will load and
  497.      save to the path\file provided by the user.  It does not, however,
  498.      modify any BBS system files on it's own.
  499.  
  500.  
  501.      SyncEdit is a trademark of Robert D. Bouman.
  502.      Synchronet is a trademark of Digital Dynamics.
  503.      All other brands are trademarks or registered trademarks of their
  504.      respective companies.
  505.